home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-05 / notepo.zip / NP_LAN.DOC < prev   
Text File  |  1992-09-29  |  16KB  |  453 lines
  1.        AI-LANBIOS Low-Level Driver For KODIAK NotePort (NOTEPORT.DOC)
  2.       -----------------------------------------------------
  3.             (C) Copyright 1991 ARTISOFT, Inc.
  4.                (Revised 9/24/92)
  5.  
  6. I. INTRODUCTION
  7.    ============
  8.  
  9. The NP_LAN_S.EXE / NP_LAN_E.EXE low-level AI-LANBIOS NotePort driver allows 
  10. you to use your Kodiak NotePort in a LANtastic network.  
  11.  
  12.     NP_LAN_S.EXE offers standard driver performance
  13.  
  14.         and
  15.  
  16.     NP_LAN_E.EXE offers enhanced performance but requires a bi-directional
  17.     printer port on the PC.
  18.  
  19. Please refer to the Kodiak NotePort Installation Guide prior to installing
  20. the LANtastic software driver. Install the NotePort as instructed, then run 
  21. the supporting software (NP_LAN_S.EXE / NP_LAN_E.EXE and AILANBIO.EXE) as
  22. detailed in the Guide.
  23.  
  24. NP_LAN_S.EXE / NP_LAN_E.EXE communicates with the NotePort, while AILANBIO.EXE 
  25. provides high-level communications across the local area network.  Because of 
  26. this, you cannot run network software until after you load NP_LAN_S.EXE / 
  27. NP_LAN_E.EXE and AILANBIO.EXE.  (Note: For information on running AILANBIO.EXE,
  28. refer to AILANBIO.DOC on your LANtastic driver diskette.)
  29.  
  30. There are command line switches that you can use when you run NP_LAN_S.EXE / 
  31. NP_LAN_E.EXE and AILANBIO.EXE.  These switches allow you greater flexibility 
  32. in using these programs.  For information on the AILANBIO.EXE command line 
  33. options refer to AILANBIO.DOC on your LANtastic driver disk.  For information on
  34. NP_LAN_S.EXE / NP_LAN_E.EXE command line switches, refer to "NP_LAN_S.EXE / 
  35. NP_LAN_E.EXE COMMAND LINE OPTIONS" in this file.
  36.  
  37. Compatibility Statement
  38. -----------------------
  39. v3.10 of NP_LAN_S.exe and NP_LAN_E.exe is compatible with Artisoft's 
  40. LANtastic/AI Network Operating System v4.1.  There are a few minor 
  41. anomalities of the adapter running on a LANtastic network, and they are
  42. documented at the final section of this file.  
  43.  
  44. Vendor Information
  45. ------------------
  46. Kodiak Technology, 1338 Ridder Park Dr., San Jose CA 95131.  Tech. Support
  47. 800-777-7704.  BBS 408-452-0677.  Customer Service Hotline 800-888-8084.
  48.  
  49. II. RUNNING NP_LAN_S.EXE / NP_LAN_E.EXE
  50.     ===================================
  51.  
  52. The syntax for running NP_LAN_S.EXE / NP_LAN_E.EXE is
  53.  
  54.      NP_LAN_S[switches . . . ] [ ; comment]
  55.         or
  56.      NP_LAN_E[switches . . . ] [ ; comment]
  57.  
  58. where "switches" denotes any optional command line switches.  If you are
  59. using more than one switch in a command line, use a space or a forward
  60. slash (/) to separate the arguments.  If a switch takes a value (such as
  61. when you designate the DOS multiplex number with the MPX= switch) the
  62. switch must be followed by an equal sign (=) or a colon (:).  All switch
  63. values are checked to make sure they are valid.  Illegal values produce
  64. error messages.
  65.  
  66. These are valid switch formats:
  67.  
  68.     SWITCH
  69.     /SWITCH
  70.     SWITCH:VALUE
  71.     /SWITCH=VALUE
  72.  
  73. You would use one of the first two formats for a switch that does not take
  74. a value.  For example:
  75.  
  76.     NP_LAN_S/HELP           or      NP_LAN_E/HELP
  77.  
  78. You would use the third or fourth formats for a switch that takes a value.
  79. Such as:
  80.  
  81.     NP_LAN_S/MPX=D7         or      NP_LAN_E/MPX=D7
  82.  
  83.  
  84. III. NP_LAN_S.EXE / NP_LAN_E.EXE COMMAND LINE OPTIONS
  85.      ================================================
  86.  
  87. The valid NP_LAN_S.EXE / NP_LAN_E.EXE switches appear below.  
  88.  
  89. - The letters "ddd" denote that you must provide a decimal number.  
  90.  
  91. - The letters "hh" denote a required hexadecimal value.  
  92.  
  93. - Values enclosed in brackets "[]" indicate default values if the switch
  94.   is omitted.  
  95.  
  96. - Values after the brackets denote the valid range of variables for the 
  97.   switch.
  98.  
  99. ----------
  100.     @switch-file
  101.  
  102. This option specifies that further switches are to be taken from an
  103. switch file.  Any switches after the @switch-file name will be used,
  104. and the switch settings take precedence over any settings in the switch
  105. file.  You may invoke switch files from within switch files as often as
  106. you wish.  The file should contain valid switches and may contain comment
  107. characters (;) at the beginning of each line or after switches.
  108.  
  109. For example,
  110.  
  111.      NP_LAN_S @setup            or      NP_LAN_E @setup
  112.  
  113. The file SETUP contains
  114.  
  115.      ; AI-LANBIOS NotePort Driver setup file
  116.      ;
  117.      MPX=D7            ; Use Multiplex number D7
  118.      IRQ=5             ; Use interrupt request 5
  119.      VERBOSE           ; Display verbose information
  120.  
  121. ----------
  122.      HELP or ?
  123.  
  124. This switch instructs NP_LAN_S.EXE / NP_LAN_E.EXE to display information about 
  125. the valid command line switches, but does not install the NotePort driver.  
  126. For example,
  127.  
  128.      NP_LAN_S/help      or      NP_LAN_E/help
  129.      NP_LAN_S ?                 NP_LAN_E ?
  130.  
  131. See the messages section for a detailed description of the HELP display
  132. output.
  133.  
  134. ----------
  135.      IRQ=d [7] 5 or 7
  136.  
  137. This switch specifies the interrupt request (IRQ) level for the parallel port
  138. adapter to which the NotePort is connected.  If you have more than one NotePort
  139. installed, that means you should have more than one parallel port adapter
  140. and each parallel port adapter should have its own unique IRQ. The IRQ switch
  141. value must match the jumper setting on the parallel port adapter.
  142.  
  143. Consult the parallel port adapter installation guide for more information
  144. on setting IRQ jumpers on the adapter.
  145.  
  146. ----------
  147.      LPT=d [1] Range 1 to 3
  148.  
  149. This switch allows you to specify the parallel port where the NotePort is 
  150. installed.  You will need to use this switch if you've installed the NotePort 
  151. on LPT2 or LPT3.
  152.  
  153. ----------
  154.      MPX=hh [C7] C0-FF
  155.  
  156. This switch specifies the DOS multiplex (MPX) number to use for
  157. communication with AILANBIO.EXE.  You will need to change this value only
  158. if the default MPX number is in use by another application or NETBIOS.
  159. Multiplex numbers 00 through BF are reserved for DOS use; therefore, you
  160. must use a multiplex number between C0 and FF.
  161.  
  162. ----------
  163.      PACKET_SIZE=dddd [1500] 574-1500
  164.  
  165. This switch specifies the maximum size of transmitted IEEE 802.3 packets.
  166. You may need to change this value when using certain bridges that do not
  167. support the full 1500-byte packet size.  Even when you reduce the packet
  168. size, the low-level driver can still receive larger packets.
  169.  
  170. ----------
  171.     REMOVE
  172.  
  173. This switch removes NP_LAN_S.EXE / NP_LAN_E.EXE from memory.  You must remove 
  174. TSR programs in the opposite order they were loaded.  
  175.  
  176. For example, if you loaded NP_LAN_S.EXE / NP_LAN_E.EXE and then AILANBIO, you 
  177. must remove AILANBIO before NP_LAN_S.EXE / NP_LAN_E.EXE. 
  178.  
  179. In addition, if you have more than one invocation of NP_LAN_S.EXE / NP_LAN_E.EXE
  180. and AILANBIO you must use the MPX= switch on the command line to specify which 
  181. copy of NP_LAN_S.EXE / NP_LAN_E.EXE but not (AILANBIO) that you want to unload.  
  182. For example, if you load two copies of NP_LAN_S.EXE / NP_LAN_E.EXE and AILANBIO:
  183.  
  184. NP_LAN_S/MPX=C7                 or      NP_LAN_E/MPX=C7
  185. AILANBIO/ADAPTER=0/MPX=C7       
  186.  
  187. NP_LAN_S/MPX=D7                 or      NP_LAN_E/MPX=D7
  188. AILANBIO/ADAPTER=1/MPX=D7
  189.  
  190. To unload these copies of NP_LAN_S.EXE / NP_LAN_E.EXE and AILANBIO:
  191.  
  192. AILANBIO/REMOVE
  193. NP_LAN_S/MPX=D7/REMOVE          or      NP_LAN_E/MPX=D7/REMOVE
  194.  
  195. AILANBIO/REMOVE
  196. NP_LAN_S/MPX=C7/REMOVE          or      NP_LAN_E/MPX=C7/REMOVE
  197.  
  198. The REMOVE option will remove the most recently run copy of AILANBIO.
  199.  
  200. ----------
  201.      VERBOSE
  202.  
  203. This switch causes the NP_LAN_S.EXE / NP_LAN_E.EXE driver to be installed and 
  204. detailed information about the configuration of the NP_LAN_S.EXE / NP_LAN_E.EXE
  205. driver to be displayed.
  206.  
  207. See the messages section for a detailed description of the VERBOSE output.
  208.  
  209. ---------
  210.      XEROX
  211.  
  212. This switch causes all transmitted packets to be in the XEROX format
  213. instead of the IEEE 802.3 standard.  When using this switch NP_LAN_S.EXE / 
  214. NP_LAN_E.EXE will receive both XEROX and IEEE 802.3 packets.
  215.  
  216.  
  217. IV. USING MULTIPLE NOTEPORTS
  218.     ========================
  219.  
  220. NP_LAN_S.EXE / NP_LAN_E.EXE and AILANBIO.EXE communicate with each other using 
  221. a DOS multiplex (MPX) number.  Each NP_LAN_S.EXE / NP_LAN_E.EXE and AILANBIO.EXE
  222. pair supports one NotePort.
  223.  
  224. You will need to run an additional copy of NP_LAN_S.EXE / NP_LAN_E.EXE and 
  225. AILANBIO.EXE for each additional NotePort installed in your computer.  Using 
  226. command line switches, you must assign each NP_LAN_S.EXE / NP_LAN_E.EXE and 
  227. AILANBIO.EXE pair a unique multiplex, adapter and IRQ number.  You must also 
  228. specify the LPT port to which each NotePort is attached.  For example:
  229.  
  230.     NP_LAN_S        or      NP_LAN_E
  231.     AILANBIO
  232.  
  233.     NP_LAN_S/IRQ=5/MPX=D7/LPT=2     or      NP_LAN_E/IRQ=5/MPX=D7/LPT=2
  234.     AILANBIO/ADAPTER=1/MPX=D7
  235.  
  236. The first invocation of NP_LAN_S.EXE / NP_LAN_E.EXE and AILANBIO.EXE loads into
  237. the first NotePort using the default MPX number (C7) interrupt request number 
  238. (7) and adapter number (0).  This NotePort is attached to LPT1.  
  239.  
  240. The command line switches in the second invocation instruct the NETBIOS to load
  241. into the second NotePort, (adapter number 1) using interrupt request 5 and DOS 
  242. MPX number D7.  This NotePort is attached to LPT2.
  243.  
  244.  
  245. V. NP_LAN_S.EXE / NP_LAN_E.EXE MESSAGES
  246.    ====================================
  247.  
  248. The NP_LAN_S.EXE / NP_LAN_E.EXE driver produces two types of messages: 
  249. Informative and Error.
  250.  
  251. All error messages are preceded by the text "ERROR:" and in those cases
  252. the NP_LAN_S.EXE / NP_LAN_E.EXE driver is not installed.
  253.  
  254. --------
  255. MESSAGE:
  256.  
  257. AI-LANBIOS NotePort driver (Standard Version) Vn.nn 
  258.  - (C) Copyright 1989, 1990 ARTISOFT Inc.
  259.  - Portions (C) Copyright 1992 Kodiak Technology, Inc.
  260.  
  261.         or
  262.  
  263. AI-LANBIOS NotePort driver (Enhanced Version) Vn.nn 
  264.  - (C) Copyright 1989, 1990 ARTISOFT Inc.
  265.  - Portions (C) Copyright 1992 Kodiak Technology, Inc.
  266.  
  267. This message appears each time the low-level driver is invoked.
  268.  
  269. --------
  270. MESSAGE:
  271.      ---- AI-LANBIOS NotePort Driver installed ----
  272.  
  273. This message appears after the low-level driver is successfully installed.
  274.  
  275. --------
  276. MESSAGE:
  277.         ---- AI-LANBIOS NotePort Driver NOT installed ----
  278.  
  279. This message appears if the low-level driver is not installed.  The driver
  280. will not be installed if HELP information is displayed or an error
  281. occurred.
  282.  
  283. --------
  284. MESSAGE:
  285.  
  286. Command line                 /verbose
  287. IEEE 802.3 node address      00801B0209D6   Network packet size  1500
  288. MPX interface number         C7             LPT port number      1 
  289. Interrupt request (IRQ)      7              LPT type             UNI-DIRECTIONAL
  290. Packet type                  IEEE 802.3     Cable type           THIN COAXIAL 
  291. Bytes of memory used         4000
  292.  
  293. This message appears if the VERBOSE switch is specified.  The values
  294. displayed specify how the low-level driver is configured.  
  295.  
  296. --------
  297. MESSAGE:
  298.  
  299. Valid command line switches:
  300.    HELP
  301.    XEROX
  302.    LPT= Range 1 to 3 decimal
  303.    IRQ= One of the following choices:
  304.       5 7
  305.    MPX= Range C0 to FF hex
  306.    PACKET_SIZE= Range 574 to 1500 decimal
  307.    REMOVE
  308.    VERBOSE
  309.    ?
  310.    @ range 0 to 2048 byte file
  311.  
  312. This message is displayed when the HELP or ? switch is used.  Each valid
  313. switch is listed with the acceptable range of values (if any) and the base
  314. (hex or decimal) that the numbers must be entered in.  The acceptable file
  315. size range for indirect files (@) is also listed.  The low-level driver is
  316. not installed when this switch is used.
  317.  
  318. -------
  319. MESSAGE:
  320.  
  321.               ---- AI-LANBIOS NotePort Driver removed ----
  322.  
  323. The NP_LAN_S.EXE / NP_LAN_E.EXE driver has been removed from memory.
  324.  
  325. --------
  326. ERROR:    AI-LANBIOS NotePort Driver not loaded
  327.  
  328. Meaning:  You have issued the NP_LAN_S/REMOVE (or NP_LAN_E/REMOVE) command and 
  329.       do not have NP_LAN_S.EXE / NP_LAN_E.EXE loaded into memory.
  330.  
  331. Remedy:   Only issue this command after the program is loaded.
  332.  
  333. -------
  334. ERROR:    Can't REMOVE -- interrupts re-hooked
  335.  
  336. Meaning:  You have attempted to remove NP_LAN_S.EXE / NP_LAN_E.EXE and the 
  337.       interrupts are in use by another TSR, or NP_LAN_S.EXE / NP_LAN_E.EXE 
  338.       was not the last TSR loaded.
  339.  
  340. Remedy:   Remove any TSRs loaded after NP_LAN_S.EXE / NP_LAN_E.EXE.  
  341.       For example, if you load NP_LAN_S.EXE / NP_LAN_E.EXE then 
  342.       AILANBIO.EXE, you must first remove AILANBIO.EXE, then you can 
  343.       remove NP_LAN_S.EXE / NP_LAN_E.EXE.
  344.  
  345. -------
  346. ERROR:    Installed AI-LANBIOS NotePort Driver is different version
  347.  
  348. Meaning:  You have loaded a version of the NP_LAN_S.EXE / NP_LAN_E.EXE program 
  349.       and attempted to remove it from memory with the /REMOVE switch.  
  350.       The version with which you are attempting to remove NP_LAN_S.EXE / 
  351.       NP_LAN_E.EXE is not the same version that was loaded.
  352.  
  353. Remedy:   Remove NP_LAN_S.EXE / NP_LAN_E.EXE with the same version of the 
  354.       program that was loaded.
  355.  
  356. ------
  357. ERROR:   Cannot open switch file - @file
  358.  
  359. Meaning: The file "file" cannot be opened as an switch file.
  360.  
  361. Remedy:  The file must exist before it can be used as an switch file.
  362.  
  363. ------
  364. ERROR:   Illegal digit in switch value - ??????=nnnn
  365.  
  366. Meaning: An illegal digit (character) occurred in the numeric
  367.      switch value.
  368.  
  369. Remedy:  You must restrict numeric decimal values to the numbers 0-9. 
  370.      You must restrict hexadecimal values to the numbers 0-9 and the
  371.      letters A-F.
  372.  
  373. ------
  374. ERROR:   Illegal switch - ??????=nnnn
  375.  
  376. Meaning: The switch ??????=nnnn is not a recognized switch.
  377.  
  378. Remedy:  You may only specify legal switches on the command line.
  379.  
  380. ------
  381. ERROR:   MPX number hh is already in use - Try another number
  382.  
  383. Meaning: The multiplex (MPX) interrupt number hh is being used by another
  384.      application or low-level driver.
  385.  
  386. Remedy:  Try another MPX number.
  387.  
  388. ------
  389. ERROR:   AI-LANBIOS NotePort Driver already loaded
  390.  
  391. Meaning: You have attempted to load a second copy of NP_LAN_S.EXE / NP_LAN_E.EXE
  392.      into the same NotePort.
  393.  
  394. Remedy:  Load only one copy of NP_LAN_S.EXE / NP_LAN_E.EXE per NotePort.  
  395.      If you use multiple NotePorts, make sure each copy of NP_LAN_S.EXE / 
  396.      NP_LAN_E.EXE has a unique MPX, IRQ and LPT value.
  397.  
  398. ------
  399. ERROR:   Either NotePort is not found at LPTn or Self-Test fails.
  400.  
  401. Meaning: NP_LAN_S.EXE / NP_LAN_E.EXE was unable to load into the NotePort.
  402.  
  403. Remedy:  Check the NotePort connection to the computer's printer port and that
  404.      the green LEDs are lit. 
  405.  
  406. ------
  407. ERROR:   Switch value not in range - ??????=nnnn
  408.      Valid range is ssss to eeee
  409.  
  410. Meaning: The value nnnn is not in proper range.  The value "ssss"
  411.      represents the lowest acceptable value and the value "eeee"
  412.      represents the highest acceptable value.
  413.  
  414. Remedy:  Limit your range of values to the acceptable range.
  415.  
  416.  
  417. VI. TESTING NP_LAN_S.EXE / NP_LAN_E.EXE RETURN CODES (ERROR LEVEL)
  418.     ==============================================================
  419.  
  420. You may test the NP_LAN_S.EXE / NP_LAN_E.EXE return code or error level in a 
  421. batch file by
  422. using the IF ERRORLEVEL command.  The following error levels are returned:
  423.  
  424.      0     No error has encountered.  NotePort Driver installed
  425.      1     MPX number is in use
  426.      2     Switch error
  427.      3     NotePort not found or Self-Test fails
  428.      4     NP_LAN_S.EXE / NP_LAN_E.EXE not loaded
  429.      5     Can't remove, different version loaded
  430.      6     Can't remove, interrupt vector re-hooked
  431.      7     ERROR: Can't REMOVE -- AI-LANBIOS (R) still installed
  432.  
  433.  
  434. VII. WARNING
  435.      =======
  436.  
  437. With some printers, it is necessary to leave the printer power on when
  438. the printer is attached to the NotePort printer connection. If you need to 
  439. power off the printer while using the NotePort, you should disconnect the
  440. printer from the NotePort before turning it off.
  441.  
  442. The Kodiak drivers cannot be loaded on most models of microchannel machines
  443. in our lab.
  444.  
  445. The enhanced driver (NP_LAN_E.exe) supports bi-directional communication on 
  446. the parallel port.  It does not support the new Xircom-Intel enhanced parallel
  447. port specifications available on i386SL chips.
  448.  
  449. -------------------
  450.  
  451. NotePort is a trademark of Kodiak Technology, Inc.
  452.  
  453.